home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / dayquote / dayquote.doc < prev    next >
Text File  |  1994-12-05  |  26KB  |  744 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                        ───────────  DayQuote  ───────────
  9.  
  10.                        (c) 1994, 1995  Freeware Unlimited
  11.  
  12.                        ──────────────────────────────────
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                                     Contents
  21.                    ──────────────────────────────────────────
  22.  
  23.                    ■ Introduction . . . . . . . . . . . . . 2
  24.  
  25.                    ■ Quote File Structure . . . . . . . . . 3
  26.  
  27.                    ■ Command Line Options . . . . . . . . . 5
  28.  
  29.                    ■ Result Messages  . . . . . . . . . . . 8
  30.  
  31.                    ──────────────────────────────────────────
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.                ╔═════════════════════════════════════════════════╗
  44.                ║                He's dead, Jim.                  ║
  45.                ║                                         - Bones ║
  46.                ╚═════════════════════════════════════════════════╝
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.                                      Page 1
  63. ────────────────────────────────────────────────────────────────────────────
  64.   ■ INTRODUCTION
  65. ────────────────────────────────────────────────────────────────────────────
  66.  
  67.  
  68.     ■ What DayQuote Is:
  69.  
  70.         It is, to be perfectly honest, the first real program I have
  71.         written, and there might exist on some plane programmers who are
  72.         self-important enough to say that even this isn't a real program.
  73.  
  74.         Nevertheless, I think you will enjoy it, and its many options.
  75.         Those hypothetical programmers I mentioned earlier might even
  76.         take a second glance at its versatile command line options.
  77.  
  78.         All of those options are described below, in their totality.
  79.         The text is concise; hence, it might be 'thick' in some places.
  80.         Please, though, if you feel justified in your critique of my
  81.         writing - either in the English language or the BASIC language -
  82.         then I would welcome your comments by snail mail.
  83.  
  84.  
  85.     ■ How It Works:
  86.  
  87.         It takes what you have typed in following its name on the command
  88.         line and then acts on the information you have given to it.
  89.         Several things can take place from there, depending upon what
  90.         you gave to it in the form of 'switches' on the command line.
  91.  
  92.         If it encounters '/?' anywhere, it will show the Help Screen,
  93.         then return you to the command line.  If it encounters the '/D'
  94.         switch, it will go into an exclusive process similar to the '/?'
  95.         switch, except that it is more comprehensive in every respect.
  96.         See the section about Command Line Options for complete details
  97.         on these options, as well as the following ones.
  98.  
  99.         Aside from those switches, there are nine other switches that
  100.         you can use to fully customize the look of your quotes.  Two of
  101.         those will control the color of the text frame displayed, and two 
  102.         others will determine how wide the frame will be.  One of them
  103.         also allows you to place the frame starting at any line on your
  104.         screen, and there is another switch that will clear the screen
  105.         before doing so.  Finally, there are three switches to choose
  106.         from that will control how the text of the quote is justified
  107.         within the frame; left- or right- or centered.
  108.  
  109.  
  110.     ■ To Get More Information:
  111.  
  112.         Type 'DAYQUOTE/$' on the command line and read about how you can
  113.         get free money sent to you, and a whole bunch of other free stuff.
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.                                      Page 2
  125. ────────────────────────────────────────────────────────────────────────────
  126.   ■ QUOTE FILE STRUCTURE
  127. ────────────────────────────────────────────────────────────────────────────
  128.  
  129.     ■ Quote file basics:
  130.  
  131.         What follows between the funky lines is a representative sample
  132.         of a valid quote file.
  133.  
  134.         /\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
  135.         | Four score and seven years ago...                            |
  136.         | ~~Abraham Lincoln                                            |
  137.         |                                                              |
  138.         | He's dead, Jim.                                              |
  139.         | ~~Bones                                                      |
  140.         |                                                              |
  141.         \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
  142.  
  143.         The basic philosophy behind it is to try grouping each body of
  144.         text as close as possible.  Each distinct quote must be separated
  145.         by a minimum of two carriage returns (Enters), including the one
  146.         at the end of the previous quote's line.  The picture again:
  147.                
  148.         /\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
  149.         | Four score and seven years ago...                            |
  150.         | ~~Abraham Lincoln «»  <──────────── carriage return 1        |
  151.         | «»  <────────────────────────────── carriage return 2        |
  152.         | He's dead, Jim.                                              |
  153.         | ~~Bones                                                      |
  154.         |                                                              |
  155.         \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
  156.  
  157.         If you slip up, though, and have, say, 42 carriage returns in there
  158.         by pure accident, don't sweat it.  The program is fairly lax in
  159.         searching for quotes, aside from the one hard rule listed above.
  160.  
  161.         It will ignore multiple spaces, as well as single carriage returns.
  162.         The text which is separated by at least two carriage returns is
  163.         considered the body of one quote, and will become one string of
  164.         text, each word separated by one space, that will be displayed
  165.         in accordance with any specified parameters, no matter how many
  166.         spaces are embedded within the quote.  You could have 113 spaces
  167.         between just two words, and the quote will display as two words
  168.         separated by a single space.  The rationale for this flexibility
  169.         is that sometimes we don't realize there are a whole bunch of
  170.         extra spaces at the end of a line, because we can't really SEE
  171.         them, so it just makes the program more forgiving of our own
  172.         imperfections.
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.                                      Page 3
  187.     ■ Creating your own quote file:
  188.  
  189.         The best way to make a quote file is to use a 'text editor' or
  190.         a 'word processor'.  If you use a word processor, make sure when
  191.         you save the file that you are saving it in 'pure ASCII', which
  192.         will mean unformatted text only, otherwise, you are apt to have
  193.         some very strange-looking quotes appearing on your screen, since
  194.         the word processor formatting codes that get added to the text
  195.         will probably not comply very much with the two-return rule.
  196.  
  197.         It is best to just type the text in as you want it to read.  Again,
  198.         how the text looks in the file will be irrelevant to how it is
  199.         displayed.  All display aspects are controlled by the optional
  200.         command line switches, and all of those switches have defaults,
  201.         so you need not worry about the display aspects until later on,
  202.         when you are more familiar with the program's operation.
  203.  
  204.         One worthy note here is that all quotes will be displayed in a
  205.         bordered rectangle, therefore it is not necessary to include
  206.         quotation characters in your quote file, unless you prefer the
  207.         look of them.  (Future releases will allow custom frame borders.)
  208.  
  209.         This documentation file was created originally by me using the
  210.         MS-DOS Editor, an easy-to use, standard ASCII text editor, and
  211.         it looked exactly as you see it now.  If you wanted to, you could
  212.         try using this documentation file as your test quote file.  Each
  213.         paragraph, since they are all separated by two carr